VintaSoft Imaging .NET SDK 14.0: Documentation for .NET developer
Vintasoft.Imaging.Codecs.Decoders Namespace / WsiDecoderBase Class / GetImage Methods / GetImage(Int32,DecodingSettings,RenderingSettings,EventHandler<ProgressEventArgs>) Method
Syntax Exceptions Requirements SeeAlso
In This Topic
    GetImage(Int32,DecodingSettings,RenderingSettings,EventHandler<ProgressEventArgs>) Method (WsiDecoderBase)
    In This Topic
    Returns an image, which is associated with the specified page of image/document source.
    Syntax
    'Declaration
    
    Public Overloads Overrides Function GetImage( _
    ByVal pageIndex
    The zero-based page index in image/document source.
    As System.Int32, _
    ByVal decodingSettings
    The decoding settings that should be used for decoding of page image.
    As DecodingSettings, _
    ByVal renderingSettings
    Rendering settings used for rendering the image of page. This parameter has effect only if IsVectorDecoder property is equal to True.
    As RenderingSettings, _
    ByVal progressDelegate
    Progress delegate.
    As System.EventHandler(Of ProgressEventArgs) _
    ) As Vintasoft.Imaging.VintasoftImage

    Parameters

    pageIndex
    The zero-based page index in image/document source.
    decodingSettings
    The decoding settings that should be used for decoding of page image.
    renderingSettings
    Rendering settings used for rendering the image of page. This parameter has effect only if IsVectorDecoder property is equal to True.
    progressDelegate
    Progress delegate.

    Return Value

    Rendered image, which is associated with the specified page of image/document source, if decoder supports rendering; otherwise, image associated with the specified page of the image source.
    Exceptions
    ExceptionDescription
    This method is not supported. To use raster grid decoder initialize {GetType().Name} using WsiCodecAssembly.Init() method.
    Requirements

    Target Platforms: .NET9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

    See Also